Name

Description

Default Value

Values

XMLSettingsURL

Pass settings xml file as flash variable.

settingsenterprise.xml

-

docLoadDelay

Controls the request time between each page.

100

10 +  any numeric value

documentname

Name of document to be displayed.

Name String Value (Required)

Any String

startPage

Page that should load when viewer opens.

1 (Required)

1 to any. Cannot have value as 0 or any alphanumeric digits or negative numbers.

Controls the order of page loading and the behavior for unloaded pages.

When this variable is set to “Yes”, the viewer loads pages sequentially and adds them to the end of the current list of pages.

When this variable is set to “No”, the viewer reserves space for pages that it has not yet loaded so the end user can scroll to them. In that case, the viewer may request visible pages from the server prior to receiving earlier pages. Setting this variable to “No” will often dramatically increase the number of requests for pages that are not yet cached on the server. For this reason, the server needs to be carefully constructed to avoid performance problems.

For more information, refer to the Using loadPagesSequentially Flash Variable topic.

toolbarButtonSize

Changes the size of the buttons in the toolbar.

36

Any numeric value

hideToolbarCategories

Turns on/off the category names in the toolbar.

Yes

Yes/No

toolbar

Removes toolbar all together.

Yes

Yes/No

interfaceColor

Changes the toolbar color.

0xff0000

Any hex code

saveDocument

(Requires setting of saveDocumentLocation)

Removes the save document options from all tabs.

Yes

Yes/No

saveDocumentLocation

Works with save button and points to original document or any other document rendition (such as pdf).

None

Link to the Original Document or pdf format of Original Document

Example:

http://www.testsite.com/ documents/originaldoc.doc

ignoreExternalLinks 

Turns off the external links on the document.

No

If set to Yes, when external links are clicked, they will not be opened automatically. 

(Look at JavaScript events viewerOnExternalLinkClick & viewerOnInternalLinkClick for using in relation to this parameter) 

copyText

Disables the option to copy text to clipboard from the viewer.

Yes

Yes/No

jsFullscreen

Traps full screen button event.

Disables fullscreen event of viewer.

Setting jsFullscreen=Yes allows override of the fullscreen event.

Set jsFullscreen=Yes and then on JS event viewerOnDocumentFullScreen (documentname) change viewer height/width to needed.

No

Yes/No

searchTab      

Turns search tab on/off.

Yes

Yes/No

viewTab          

Turns view tab on/off.

Yes

Yes/No

translationTool

Turns translation on/off.

Yes

Yes/No

selectedTab     

Tab to select when document first loads.

Home

Name of the tab.

Example:

selectedTab:’Home’

selectedTab:’Search’

selectedTab:’खोज’

If using translation, pass the translated tab name to load it on document load.

Name

Description

Default Value

Values

buttonHomeSave

buttonHomePrint

buttonHomeZoom

buttonHomeFit

buttonHomeLeft

buttonHomeRight

buttonHomeClip

buttonHomeFullscreen

buttonSearch

buttonSearchFullScreen

buttonViewFit

buttonViewRotate

buttonViewThumbs

buttonViewFullScreen

buttonTranslateFullscree

Allows you to independently turn off buttons on Home tab.

Example:

buttonHomeZoom=No

Yes

All buttons are on by default.

Yes/No

Name

Description

printOptionPrintAll

Allows you to remove Print All Pages options in the print dialog box.

Yes/No

printOptionPrintPageRange

Allows you to remove Print Page Range option in the print dialog box.

Yes/No

printOptionPrintCurrentPage

Allows you to remove Print Current Page option in the print dialog box.

Yes/No

Name

Description

customTabName

Name of custom tab.

customTabCategoryName

Category name for custom buttons. All buttons get added to 1 category.

customButton1Image

Image to appear on button.

customButton1Url

URL to go to when button is clicked.

customButton1Target

Target for url, like _blank, _top, etc.

customButton1Tooltip

Tooltip for the custom button.

Name

Description

Default Value

Values

searchQuery

Load viewer with search keywords highlighted.

 None

Can be any keywords in the document

highlightsLinksXML

Pass search variables in xml form.

 None

xml

highlightsLinksXMLURL

Pass search variables in a url to a xml.

 None

Link to xml

Name

Description

Default Value

Values

reviewTab

Turns review tab on or off.

Yes

Yes/No

turnOffClickMenu

Turns off the on click menu when set to Yes. On Click menu shows options such as “Add Link”, “Add Highlight”, “Copy Text”.

No

Yes/No

saveAnnotation

Enables users to save annotations, or disables save.

Yes

Yes/No

openAnnotation

Enables or disables opening of annotation files by the users.

Example use case: pre-load an annotation (use loadAnnotation) and disable opening other annotations.

Yes

Yes/No

loadAnnotation

Pre-loads annotations.

None 

Annotation file name

saveAnnotationAs

Forces annotation xml to be saved automatically by the defined name. (Disables the annotation save popup.)

None 

Annotation file name

(DEPRECATED, use function "saveAnnotations(true/false)" instead)

suppressSaveAnnotationNotice

Forces annotation xml to be saved automatically by the name defined in the "saveAnnotationAs" flash variable. (Disables the annotation save popup.)

No

Yes/No

stamps

Sets predefined Stamp values. If no stamp values are set, Stamp selector appears blank.

Required to be set.

APPROVED|REVIEWED|REJECTED 

stamps=APPROVED|DENIED|REVIEW|REJECTED

Pass stamps as text separated by a pipe delimiter "|".

printAnnotations

Turns on/off the print annotations option checkbox. (Print Annotation checkbox appears when users click on Print button in Viewer.)

Yes

Yes/No